home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / zgesvd.z / zgesvd
Encoding:
Text File  |  2002-10-03  |  7.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ZZZZGGGGEEEESSSSVVVVDDDD((((3333SSSS))))                                                          ZZZZGGGGEEEESSSSVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZGESVD - compute the singular value decomposition (SVD) of a complex M-
  10.      by-N matrix A, optionally computing the left and/or right singular
  11.      vectors
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE ZGESVD( JOBU, JOBVT, M, N, A, LDA, S, U, LDU, VT, LDVT, WORK,
  15.                         LWORK, RWORK, INFO )
  16.  
  17.          CHARACTER      JOBU, JOBVT
  18.  
  19.          INTEGER        INFO, LDA, LDU, LDVT, LWORK, M, N
  20.  
  21.          DOUBLE         PRECISION RWORK( * ), S( * )
  22.  
  23.          COMPLEX*16     A( LDA, * ), U( LDU, * ), VT( LDVT, * ), WORK( * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      ZGESVD computes the singular value decomposition (SVD) of a complex M-
  40.      by-N matrix A, optionally computing the left and/or right singular
  41.      vectors. The SVD is written
  42.           A = U * SIGMA * conjugate-transpose(V)
  43.  
  44.      where SIGMA is an M-by-N matrix which is zero except for its min(m,n)
  45.      diagonal elements, U is an M-by-M unitary matrix, and V is an N-by-N
  46.      unitary matrix.  The diagonal elements of SIGMA are the singular values
  47.      of A; they are real and non-negative, and are returned in descending
  48.      order.  The first min(m,n) columns of U and V are the left and right
  49.      singular vectors of A.
  50.  
  51.      Note that the routine returns V**H, not V.
  52.  
  53.  
  54. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  55.      JOBU    (input) CHARACTER*1
  56.              Specifies options for computing all or part of the matrix U:
  57.              = 'A':  all M columns of U are returned in array U:
  58.              = 'S':  the first min(m,n) columns of U (the left singular
  59.              vectors) are returned in the array U; = 'O':  the first min(m,n)
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZGGGGEEEESSSSVVVVDDDD((((3333SSSS))))                                                          ZZZZGGGGEEEESSSSVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              columns of U (the left singular vectors) are overwritten on the
  75.              array A; = 'N':  no columns of U (no left singular vectors) are
  76.              computed.
  77.  
  78.      JOBVT   (input) CHARACTER*1
  79.              Specifies options for computing all or part of the matrix V**H:
  80.              = 'A':  all N rows of V**H are returned in the array VT;
  81.              = 'S':  the first min(m,n) rows of V**H (the right singular
  82.              vectors) are returned in the array VT; = 'O':  the first min(m,n)
  83.              rows of V**H (the right singular vectors) are overwritten on the
  84.              array A; = 'N':  no rows of V**H (no right singular vectors) are
  85.              computed.
  86.  
  87.              JOBVT and JOBU cannot both be 'O'.
  88.  
  89.      M       (input) INTEGER
  90.              The number of rows of the input matrix A.  M >= 0.
  91.  
  92.      N       (input) INTEGER
  93.              The number of columns of the input matrix A.  N >= 0.
  94.  
  95.      A       (input/output) COMPLEX*16 array, dimension (LDA,N)
  96.              On entry, the M-by-N matrix A.  On exit, if JOBU = 'O',  A is
  97.              overwritten with the first min(m,n) columns of U (the left
  98.              singular vectors, stored columnwise); if JOBVT = 'O', A is
  99.              overwritten with the first min(m,n) rows of V**H (the right
  100.              singular vectors, stored rowwise); if JOBU .ne. 'O' and JOBVT
  101.              .ne. 'O', the contents of A are destroyed.
  102.  
  103.      LDA     (input) INTEGER
  104.              The leading dimension of the array A.  LDA >= max(1,M).
  105.  
  106.      S       (output) DOUBLE PRECISION array, dimension (min(M,N))
  107.              The singular values of A, sorted so that S(i) >= S(i+1).
  108.  
  109.      U       (output) COMPLEX*16 array, dimension (LDU,UCOL)
  110.              (LDU,M) if JOBU = 'A' or (LDU,min(M,N)) if JOBU = 'S'.  If JOBU =
  111.              'A', U contains the M-by-M unitary matrix U; if JOBU = 'S', U
  112.              contains the first min(m,n) columns of U (the left singular
  113.              vectors, stored columnwise); if JOBU = 'N' or 'O', U is not
  114.              referenced.
  115.  
  116.      LDU     (input) INTEGER
  117.              The leading dimension of the array U.  LDU >= 1; if JOBU = 'S' or
  118.              'A', LDU >= M.
  119.  
  120.      VT      (output) COMPLEX*16 array, dimension (LDVT,N)
  121.              If JOBVT = 'A', VT contains the N-by-N unitary matrix V**H; if
  122.              JOBVT = 'S', VT contains the first min(m,n) rows of V**H (the
  123.              right singular vectors, stored rowwise); if JOBVT = 'N' or 'O',
  124.              VT is not referenced.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZGGGGEEEESSSSVVVVDDDD((((3333SSSS))))                                                          ZZZZGGGGEEEESSSSVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDVT    (input) INTEGER
  141.              The leading dimension of the array VT.  LDVT >= 1; if JOBVT =
  142.              'A', LDVT >= N; if JOBVT = 'S', LDVT >= min(M,N).
  143.  
  144.      WORK    (workspace/output) COMPLEX*16 array, dimension (LWORK)
  145.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  146.  
  147.      LWORK   (input) INTEGER
  148.              The dimension of the array WORK. LWORK >= 1.  LWORK >=
  149.              2*MIN(M,N)+MAX(M,N).  For good performance, LWORK should
  150.              generally be larger.
  151.  
  152.              If LWORK = -1, then a workspace query is assumed; the routine
  153.              only calculates the optimal size of the WORK array, returns this
  154.              value as the first entry of the WORK array, and no error message
  155.              related to LWORK is issued by XERBLA.
  156.  
  157.      RWORK   (workspace) DOUBLE PRECISION array, dimension (5*min(M,N))
  158.              On exit, if INFO > 0, RWORK(1:MIN(M,N)-1) contains the
  159.              unconverged superdiagonal elements of an upper bidiagonal matrix
  160.              B whose diagonal is in S (not necessarily sorted).  B satisfies A
  161.              = U * B * VT, so it has the same singular values as A, and
  162.              singular vectors related by U and VT.
  163.  
  164.      INFO    (output) INTEGER
  165.              = 0:  successful exit.
  166.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  167.              > 0:  if ZBDSQR did not converge, INFO specifies how many
  168.              superdiagonals of an intermediate bidiagonal form B did not
  169.              converge to zero. See the description of RWORK above for details.
  170.  
  171. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  172.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  173.  
  174.      This man page is available only online.
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.